Developer CD Series 1996 February: Tool Chest/Apple Developer CD Series Tool Chest February 1996 (Apple Computer)(1996).iso/Tool Chest/Interfaces & Libraries/Interfaces/PInterfaces/PCCardTuples.p

Text File | 1995-08-23 | 12.8 KB | 421 lines | [TEXT/MPS ]

{
     File:        PCCardTuples.p

     Contains:    List of PCMCIA tuple types and definitions of tuple contents.

     Version:    Technology: PCMCIA Software 2.0
                Package:    Universal Interfaces 2.1.1 in “MPW Latest” on ETO #19

     Copyright:    © 1984-1995 by Apple Computer, Inc.
                 All rights reserved.

     Bugs?:        If you find a problem with this file, use the Apple Bug Reporter
                 stack.  Include the file and version information (from above)
                 in the problem description and send to:
                     Internet:    [e-mail]
                     AppleLink:    APPLE.BUGS

}

{$IFC UNDEFINED UsingIncludes}
{$SETC UsingIncludes := 0}
{$ENDC}

{$IFC NOT UsingIncludes}
 UNIT PCCardTuples;
 INTERFACE
{$ENDC}

{$IFC UNDEFINED __PCCARDTUPLES__}
{$SETC __PCCARDTUPLES__ := 1}

{$I+}
{$SETC PCCardTuplesIncludes := UsingIncludes}
{$SETC UsingIncludes := 1}


{$IFC UNDEFINED __TYPES__}
{$I Types.p}
{$ENDC}
{    ConditionalMacros.p                                            }

{$PUSH}
{$ALIGN MAC68K}
{$LibExport+}

CONST
    MAX_TUPLE_SIZE                = 256;

{————————————————————————————————————————————————————————————————————————
    Defines for Tuple codes
————————————————————————————————————————————————————————————————————————}
    CISTPL_NULL                    = $00;
    CISTPL_DEVICE                = $01;
    CISTPL_LONGLINK_MFC            = $06;
    CISTPL_CHECKSUM                = $10;
    CISTPL_LONGLINK_A            = $11;
    CISTPL_LONGLINK_C            = $12;
    CISTPL_LINKTARGET            = $13;
    CISTPL_NO_LINK                = $14;
    CISTPL_VERS_1                = $15;
    CISTPL_ALTSTR                = $16;
    CISTPL_DEVICE_A                = $17;
    CISTPL_JEDEC_C                = $18;
    CISTPL_JEDEC_A                = $19;
    CISTPL_CONFIG                = $1A;
    CISTPL_CFTABLE_ENTRY        = $1B;
    CISTPL_DEVICE_OC            = $1C;
    CISTPL_DEVICE_OA            = $1D;
    CISTPL_DEVICE_GEO            = $1E;
    CISTPL_DEVICE_GEO_A            = $1F;
    CISTPL_MANFID                = $20;
    CISTPL_FUNCID                = $21;
    CISTPL_FUNCE                = $22;
    CISTPL_SWIL                    = $23;
    CISTPL_VERS_2                = $40;
    CISTPL_FORMAT                = $41;
    CISTPL_GEOMETRY                = $42;
    CISTPL_BYTEORDER            = $43;
    CISTPL_DATE                    = $44;
    CISTPL_BATTERY                = $45;
    CISTPL_ORG                    = $46;
    CISTPL_VENDOR                = $FE;
    CISTPL_END                    = $FF;

{————————————————————————————————————————————————————————————————————————
    Tuple Data Block Definitions
————————————————————————————————————————————————————————————————————————}
{------------    Device Information Tuple (01H, 17H)    -----------                            }

TYPE
    DeviceIDTuple = RECORD
        TPLDEV_TYPE_WPS_SPEED:    SInt8; (* Byte *)                        { Device Type Code: 7-4, WPS: 3,  Device Speed: 2-0}
        deviceData:                ARRAY [0..MAX_TUPLE_SIZE - 3-1] OF SInt8; (* Byte *)
    END;


CONST
    TPLDEV_TYPE_MASK            = $F0;                            { device type mask for TPLDEV_TYPE_WPS_SPEED}
    TPLDEV_TYPE_EXTENDED        = $E0;                            { device type value for extended type}
    TPLDEV_WPS_MASK                = $08;                            { write-protect switch mask for TPLDEV_TYPE_WPS_SPEED}
    TPLDEV_SPEED_MASK            = $07;                            { device speed mask for TPLDEV_TYPE_WPS_SPEED}
    TPLDEV_DSPEED_NULL            = $00;                            { speed for null device type}
    TPLDEV_DSPEED_250NS            = $01;                            { 250ns card access time}
    TPLDEV_DSPEED_200NS            = $02;                            { 200ns card access time}
    TPLDEV_DSPEED_150NS            = $03;                            { 150ns card access time}
    TPLDEV_DSPEED_100NS            = $04;                            { 100ns card access time}
    TPLDEV_EXTENDED_SPEED        = $07;                            { device speed value for extended speed}
    TPLDEV_SPEED_EXPONENT        = $07;                            { extended byte exponent mask}
    TPLDEV_SPEED_MANTISSA        = $78;                            { extended byte mantissa mask}
    TPLDEV_SPEED_EXTENDED_MASK    = $80;                            { bit set if more extended speed data follows}

{    device ID types}
    DTYPE_NULL                    = 0;
    DTYPE_ROM                    = 1;
    DTYPE_OTPROM                = 2;
    DTYPE_EPROM                    = 3;
    DTYPE_EEPROM                = 4;
    DTYPE_FLASH                    = 5;
    DTYPE_SRAM                    = 6;
    DTYPE_DRAM                    = 7;
    DTYPE_FUNCSPEC                = $0D;
    DTYPE_EXTEND                = 14;

{---------------    Checksum Control Tuple (10H)    ---------------                            }

TYPE
    ChecksumControlTuple = RECORD
        TPLCKS_ADDR:            INTEGER;                                { offset to region to be checksummed, LSB first}
        TPLCKS_LEN:                INTEGER;                                { length of region to be checksummed, LSB first}
        TPLCKS_CS:                CHAR;                                    { checksum of the region}
        reserved:                SInt8; (* Byte *)                        { padding}
    END;

{----------------    Long Link Multi-Function Tuple (06H)    ------                    }
    LongLinkMFCTuple = RECORD
        TPLMFC_NUM:                SInt8; (* UInt8 *)                        { Number of sets of config registers for individual functions}
        TPLMFC_TAS1:            SInt8; (* UInt8 *)                        { CIS target address space for first function (00 = Attr, 01 = Common)}
        TPLMFC_ADDR1:            UInt32;                                    { Target address of first CIS, unsigned long, lsb first}
        TPLMFC_TAS2:            SInt8; (* UInt8 *)                        { CIS target address space for second function (00 = Attr, 01 = Common)}
        TPLMFC_ADDR2:            UInt32;                                    { Target address of second CIS, unsigned long, lsb first}
        { the following fields are of undetermined length and should be calculated at runtime}
        { }
        { UInt8        TPLMFC_TASn;}
        { UInt32        TPLMFC_ADDRn;}
    END;

{----------------    Long Link Tuple (11H, 12H)    ----------------                            }
    LongLinkTuple = RECORD
        TPLL_ADDR:                UInt32;                                    { target address, LSB first}
    END;

{-----------------    Link Target Tuple (13H)    ------------------                            }
    LinkTargetTuple = RECORD
        TPLL_TAG:                ARRAY [0..2] OF SInt8; (* Byte *)        { tag: should be 'C', 'I', 'S'}
    END;

{----------------    Level 1 Version Tuple (15H)    ---------------                            }
    Level1VersionTuple = RECORD
        TPLLV1_MAJOR:            SInt8; (* Byte *)                        { major version number (0x04)}
        TPLLV1_MINOR:            SInt8; (* Byte *)                        { minor version number (0x01 for release 2.0 and 2.01)}
        TPLLV1_INFO:            ARRAY [0..0] OF SInt8; (* Byte *)        { product information string, zero-terminated}
    END;

{-------------    JEDEC Identifier Tuple (18H, 19H)    ------------                            }
    JEDECDeviceInfo = RECORD
        manufacturerID:            SInt8; (* Byte *)
        manufacturerInfo:        SInt8; (* Byte *)
    END;

    JEDECIdentifierTuple = RECORD
        device:                    ARRAY [0..0] OF JEDECDeviceInfo;
    END;

{---------    Configuration Tuple (1AH)    ----------                            }
    ConfigTuple = RECORD
        TPCC_SZ:                SInt8; (* Byte *)                        { size of fields byte}
        TPCC_LAST:                SInt8; (* Byte *)                        { index number of last config entry}
        TPCC_RADR:                SInt8; (* Byte *)                        { config reg's base addr in reg. space}
        reserved:                SInt8; (* Byte *)                        { padding}
        { the following fields are of undetermined length and should be calculated at runtime}
        {UInt32            TPCC_RMSK;}
        {UInt32            TPCC_RSVD;}
        {UInt32            TPCC_SBTPL;}
    END;

{    TPCC_RADR field definitions}

CONST
    TPCC_RASZ                    = $03;                            { bits 1-0}
    TPCC_RMSZ                    = $3C;                            { bits 5-2}
    TPCC_RFSZ                    = $C0;                            { bits 7-6}

{---------    Device Geometry Tuple (1EH, 1FH)    ----------}

TYPE
    DeviceGeometry = RECORD
        DGTPL_BUS:                SInt8; (* UInt8 *)                        { system bus width = 2^(n-1), n>0}
        DGTPL_EBS:                SInt8; (* UInt8 *)                        { erase block size = 2^(n-1), n>0}
        DGTPL_RBS:                SInt8; (* UInt8 *)                        { read block size = 2^(n-1), n>0}
        DGTPL_WBS:                SInt8; (* UInt8 *)                        { write block size = 2^(n-1), n>0}
        DGTPL_PART:                SInt8; (* UInt8 *)                        { partitioning size = 2^(n-1), n>0}
        DGTPL_HWIL:                SInt8; (* UInt8 *)                        { hardware interleave = 2^(n-1), n>0}
    END;

    DeviceGeometryTuple = RECORD
        device:                    ARRAY [0..41] OF DeviceGeometry;
    END;

{---------    Manufacturer Identification Tuple (20H)    ----------                            }
    ManufIDTuple = RECORD
        TPLMID_MANF:            INTEGER;                                { PCMCIA PC Card manufacturer code}
        TPLMID_CARD:            INTEGER;                                { manufacturer information (part number and/or revision)}
    END;

{-----------    Function Identification Tuple (21H)    ------------                            }
    FunctionIDTuple = RECORD
        TPLFID_FUNCTION:        SInt8; (* Byte *)                        { PC card function code}
        TPLFID_SYSINIT:            SInt8; (* Byte *)                        { system initialization bit mask}
    END;

{    function codes}

CONST
    TPLFID_MultiFunction        = 0;
    TPLFID_Memory                = 1;
    TPLFID_SerialPort            = 2;
    TPLFID_ParallelPort            = 3;
    TPLFID_FixedDisk            = 4;
    TPLFID_VideoAdaptor            = 5;
    TPLFID_NetworkLANAdaptor    = 6;
    TPLFID_AIMS                    = 7;

{------------    Software Interleave Tuple (23H)    ---------------                            }

TYPE
    SoftwareInterleaveTuple = RECORD
        TPLSWIL_INTRLV:            CHAR;                                    { software interleave}
    END;

{-------    Level 2 Version and Information Tuple (40H)    --------                            }
    Level2VersionTuple = RECORD
        TPLLV2_VERS:            SInt8; (* Byte *)                        { structure version (0x00)}
        TPLLV2_COMPLY:            SInt8; (* Byte *)                        { level of compliance with the standard (0x00)}
        TPLLV2_DINDEX:            UInt16;                                    { byte address of first data byte in card, LSB first}
        TPLLV2_RSV6:            SInt8; (* Byte *)                        { reserved, must be zero}
        TPLLV2_RSV7:            SInt8; (* Byte *)                        { reserved, must be zero}
        TPLLV2_VSPEC8:            SInt8; (* Byte *)                        { vendor specific byte}
        TPLLV2_VSPEC9:            SInt8; (* Byte *)                        { vendor specific byte}
        TPLLV2_NHDR:            CHAR;                                    { number of copies of CIS present on this device}
        TPLLV2_OEM:                ARRAY [0..0] OF CHAR;                    { vendor of software that formatted card, zero-terminated}
        TPLLV2_INFO:            ARRAY [0..0] OF CHAR;                    { informational message about the card, zero-terminated}
        reserved:                SInt8; (* Byte *)                        { padding}
    END;

{--------------------    Format Tuple (41H)    --------------------                            }
{ additional information for disk type:}
    FormatDiskTuple = RECORD
        TPLFMT_BKSZ:            UInt16;                                    {    block size, or zero if unblocked format}
        TPLFMT_NBLOCKS:            UInt32;                                    {    number of data blocks in this partition}
        TPLFMT_EDCLOC:            UInt32;                                    {    location of error detection code, or zero if interleaved}
    END;

{ additional information for disk type:}
    FormatMemTuple = RECORD
        TPLFMT_FLAGS:            SInt8; (* Byte *)                        {    various flags}
        TPLFMT_RESERVED:        SInt8; (* Byte *)                        {    reserved, set to zero}
        TPLFMT_ADDRESS:            UInt32;                                    {    physical location at which this memory partion must be mapped}
        TPLFMT_EDCLOC:            UInt32;                                    {    location of error detection code, or zero if interleaved}
    END;

    FormatTuple = RECORD
        TPLFMT_TYPE:            CHAR;                                    { format type code}
        TPLFMT_EDC:                CHAR;                                    { error detection method and length of error detection code}
        TPLFMT_OFFSET:            LONGINT;                                { offset to first data byte in this partition}
        TPLFMT_NBYTES:            LONGINT;                                { number of data bytes in this partition}
        CASE INTEGER OF
        0: (
            TPLFMT_DISK:                FormatDiskTuple;
           );
        1: (
            TPLFMT_MEM:                    FormatMemTuple;
           );

    END;

{    format types}

CONST
    TPLFMTTYPE_DISK                = 0;
    TPLFMTTYPE_MEM                = 1;
    TPLFMTTYPE_VS                = $80;

{    error detection types}
    TPLFMTEDC_NONE                = 0;
    TPLFMTEDC_CKSUM                = 1;
    TPLFMTEDC_CRC                = 2;
    TPLFMTEDC_PCC                = 3;
    TPLFMTEDC_VS                = 8;

{    bits in TPLFMT_FLAGS}
    TPLFMTFLAGS_ADDR            = 0;
    TPLFMTFLAGS_AUTO            = 1;

{------------------    Geometry Tuple (42H)    --------------------                            }

TYPE
    GeometryTuple = RECORD
        TPLGEO_SPT:                CHAR;                                    { number of sectors per track}
        TPLGEO_TPC:                CHAR;                                    { number of tracks per cylinder}
        TPLGEO_NCYL:            INTEGER;                                { number of cylinders, total}
    END;

{-----------------    Byte-Order Tuple (43H)    -------------------                            }
    ByteOrderTuple = RECORD
        TPLBYTE_ORDER:            CHAR;                                    { byte order code}
        TPLBYTE_MAP:            CHAR;                                    { byte mapping code}
    END;

{    byte order codes}

CONST
    TYPBYTEORD_LOW                = 0;
    TYPBYTEORD_HIGH                = 1;
    TYPBYTEORD_VS                = $80;

{    byte mapping codes}
    TYPBYTEMAP_LOW                = 0;
    TYPBYTEMAP_HIGH                = 1;
    TYPBYTEMAP_VS                = $80;

{----------    Card Initialization Date Tuple (44H)    ------------                            }

TYPE
    CardInitDateTuple = RECORD
        TPLDATE_TIME:            UInt16;                                    { hours, minutes, seconds}
        TPLDATE_DAY:            UInt16;                                    { year, month, day}
    END;

{----------    Battery-Replacement Date Tuple (45H)    ------------                            }
    BatteryReplaceDateTuple = RECORD
        TPLBATT_RDAY:            UInt16;                                    { last replacement date (year, month, day)}
        TPLBATT_XDAY:            UInt16;                                    { battery expiration date (year, month, day)}
    END;

{----------------------    General Tuple    -----------------------                            }
    TupleBody = RECORD
        CASE INTEGER OF
        0: (
            deviceID:                    DeviceIDTuple;
           );
        1: (
            checksum:                    ChecksumControlTuple;
           );
        2: (
            link:                        LongLinkTuple;
           );
        3: (
            target:                        LinkTargetTuple;
           );
        4: (
            level1:                        Level1VersionTuple;
           );
        5: (
            jedecID:                    JEDECIdentifierTuple;
           );
        6: (
            config:                        ConfigTuple;
           );
        7: (
            devGeo:                        DeviceGeometryTuple;
           );
        8: (
            manufID:                    ManufIDTuple;
           );
        9: (
            funcID:                        FunctionIDTuple;
           );
        10: (
            swil:                        SoftwareInterleaveTuple;
           );
        11: (
            level2:                        Level2VersionTuple;
           );
        12: (
            format:                        FormatTuple;
           );
        13: (
            geometry:                    GeometryTuple;
           );
        14: (
            order:                        ByteOrderTuple;
           );
        15: (
            initDate:                    CardInitDateTuple;
           );
        16: (
            battDate:                    BatteryReplaceDateTuple;
           );
        17: (
            tupleData:                    ARRAY [0..MAX_TUPLE_SIZE - 2-1] OF SInt8; (* Byte *)
           );
    END;

    Tuple = RECORD
        TPL_CODE:                SInt8; (* Byte *)
        TPL_LINK:                SInt8; (* Byte *)
        TPL_BODY:                TupleBody;
    END;


{$ALIGN RESET}
{$POP}

{$SETC UsingIncludes := PCCardTuplesIncludes}

{$ENDC} {__PCCARDTUPLES__}

{$IFC NOT UsingIncludes}
 END.
{$ENDC}